Skip to content

Fix vale lint command to exclude node_modules directory #457

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom
Merged
merged 2 commits into from
Jul 22, 2025
Merged

Fix vale lint command to exclude node_modules directory #457

merged 2 commits into from
Jul 22, 2025

Conversation

Copilot
Copy link
Contributor

@Copilot Copilot AI commented Jun 30, 2025 •
edited
Loading

The invoke lint command was including files from the node_modules directory when the docusaurus package is installed, causing performance issues and thousands of irrelevant linting errors.

Problem

When running invoke lint locally with docusaurus packages installed, the vale linter would process all markdown files in docs/node_modules/, resulting in:

  • 1,795 total files processed (1,761 from node_modules + 34 actual docs)
  • 18,369 errors and 6,952 warnings from third-party package documentation
  • Significantly increased linting time

Solution

Modified the find command in the lint_vale function to exclude the node_modules directory:

# Before
exec_cmd = r'vale $(find ./docs -type f \( -name "*.mdx" -o -name "*.md" \))'

# After  
exec_cmd = r'vale $(find ./docs -type f \( -name "*.mdx" -o -name "*.md" \) -not -path "*/node_modules/*")'

Impact

  • Before: 1,795 files processed
  • After: 34 files processed (only actual documentation files)
  • Eliminates thousands of irrelevant errors from npm package documentation
  • Maintains backward compatibility when node_modules doesn't exist
  • Significantly improves linting performance

Fixes #372.

💡 You can make Copilot smarter by setting up custom instructions, customizing its development environment and configuring Model Context Protocol (MCP) servers. Learn more Copilot coding agent tips in the docs.

@cloudflare-workers-and-pages Cloudflare Workers and Pages
Copy link

cloudflare-workers-and-pages bot commented Jun 30, 2025 •
edited
Loading

Deploying infrahub-sdk-python with  Cloudflare Pages  Cloudflare Pages

Latest commit: 265c9f0
Status: ✅  Deploy successful!
Preview URL: https://6d1243be.infrahub-sdk-python.pages.dev
Branch Preview URL: https://copilot-fix-372.infrahub-sdk-python.pages.dev

View logs

@Copilot Copilot AI changed the title [WIP] task: Remove node module from vale lint command Fix vale lint command to exclude node_modules directory Jun 30, 2025
@Copilot Copilot AI requested a review from dgarros June 30, 2025 07:31
Copilot finished work on behalf of dgarros June 30, 2025 07:31
@dgarros dgarros marked this pull request as ready for review July 22, 2025 20:06
@coderabbitai coderabbitai
Copy link

coderabbitai bot commented Jul 22, 2025

Important

Review skipped

Bot user detected.

To trigger a single review, invoke the @coderabbitai review command.

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.

🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

  • Review comments: Directly reply to a review comment made by CodeRabbit. Example:
    • I pushed a fix in commit <commit_id>, please review it.
    • Explain this complex logic.
    • Open a follow-up GitHub issue for this discussion.
  • Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
    • @coderabbitai explain this code block.
    • @coderabbitai modularize this function.
  • PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
    • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
    • @coderabbitai read src/utils.ts and explain its main purpose.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
    • @coderabbitai help me debug CodeRabbit configuration file.

Support

Need help? Join our Discord community for assistance with any issues or questions.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai full review to do a full review from scratch and review all the files again.
  • @coderabbitai summary to regenerate the summary of the PR.
  • @coderabbitai generate sequence diagram to generate a sequence diagram of the changes in this PR.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
  • @coderabbitai help to get help.

Other keywords and placeholders

  • Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
  • Add @coderabbitai summary or Summary to generate the high-level summary at a specific location in the PR description.
  • Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

  • You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
  • Please see the configuration documentation for more information.
  • If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

  • Visit our Documentation for detailed information on how to use CodeRabbit.
  • Join our Discord Community to get help, request features, and share feedback.
  • Follow us on X/Twitter for updates and announcements.

@codecov Codecov
Copy link

codecov bot commented Jul 22, 2025 •
edited
Loading

Codecov Report

All modified and coverable lines are covered by tests ✅

@@           Coverage Diff           @@
##           stable     #457   +/-   ##
=======================================
  Coverage   75.58%   75.58%           
=======================================
  Files         100      100           
  Lines        8769     8769           
  Branches     1712     1712           
=======================================
  Hits         6628     6628           
  Misses       1663     1663           
  Partials      478      478
Flag Coverage Δ
integration-tests 34.62% <ø> (ø)
python-3.10 47.90% <ø> (-0.03%) ⬇️
python-3.11 47.90% <ø> (-0.03%) ⬇️
python-3.12 47.90% <ø> (ø)
python-3.13 47.88% <ø> (-0.03%) ⬇️
python-3.9 46.60% <ø> (ø)
python-filler-3.12 25.23% <ø> (ø)

Flags with carried forward coverage won't be shown. Click here to find out more.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

@dgarros dgarros merged commit ef7fc07 into stable Jul 22, 2025
23 of 32 checks passed
@dgarros dgarros deleted the copilot/fix-372 branch July 22, 2025 20:24
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers
1 more reviewer

@dgarros dgarros dgarros approved these changes

Reviewers whose approvals may not affect merge requirements
Assignees

@dgarros dgarros

Copilot code review Copilot

Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

task: Remove node module from vale lint command
2 participants
@Copilot @dgarros